RtCommitLockStack

RtCommitLockStack commits and locks the specified stack to avoid page faults as the stack is used.

Syntax

BOOL RtCommitLockStack(
    ULONG nNumberOfBytes
);

Parameters

nNumberOfBytes

The number of bytes in the stack to lock.

Return Values

TRUE if the function completes successfully, FALSE if invalid parameters are specified

Remarks

RtCommitLockStack commits and locks the stack in physical memory so that it does not incur page faults as the memory is used, and the memory used for the stack is not paged out by the system.

The RTSS stack is always locked. Any attempt to lock the stack beyond the stack size at thread creation fails; otherwise, this call has no effect in the RTSS environment.

Requirements

Header	Rtapi.h
Library	rtapi_w32.lib (Windows), Rtx_Rtss.lib (RTSS)